Skip to main content
Version: 24.03
deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

Get page of legal entities from the output stage. Can optionally be filtered by external IDs.

Query Parameters
  • page string

    Default value: 0

    Number of page to get results from

  • size string

    Possible values: <= 100

    Default value: 10

    Size of each page

Request Body array
  • string
Responses

The requested page of legal entities

Schema
  • totalElements int64

    Total number of all results in all pages

  • totalPages int32

    Total number pages

  • page int32

    Current page number

  • contentSize int32

    Number of results in the page

  • content object[]

    Collection of results in the page

  • legalNameParts string[]

    The list of name parts of the legal entity to accommodate the different number of name fields in different systems.

  • identifiers object[]

    The list of identifiers of the legal entity.

  • value string

    The value of the identifier like "DE123465789".

  • type string

    The type of the identifier.

  • issuingBody string

    The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Handelsregister.

  • legalShortName string

    The abbreviated name of the legal entity.

  • legalForm string

    The legal form of the legal entity.

  • states object[]

    The list of (temporary) states of the legal entity.

  • description string
  • validFrom date-time

    The date from which the state is valid.

  • validTo date-time

    The date until the state is valid.

  • type string

    Possible values: [ACTIVE, INACTIVE]

    One of the state types: active, inactive.

  • classifications object[]

    The list of classifications of the legal entity, such as a specific industry.

  • type string

    Possible values: [NACE, NAF, NAICS, SIC]

    Type of classification.

  • code string

    The identifier of the class belonging to the classification.

  • value string

    The name of the class belonging to the classification.

  • roles string[]

    Possible values: [SUPPLIER, CUSTOMER, ONE_TIME_SUPPLIER, ONE_TIME_CUSTOMER]

    Roles this business partner takes in relation to the sharing member.

  • confidenceCriteria object
  • sharedByOwner boolean
  • checkedByExternalDataSource boolean
  • numberOfBusinessPartners int32
  • lastConfidenceCheckAt date-time
  • nextConfidenceCheckAt date-time
  • confidenceLevel int32
  • legalAddress object

    In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA.

  • nameParts string[]

    The list of name parts of the address to accommodate the different number of name fields in different systems. This is not according to official registers but according to the name the sharing member chooses.

  • states object[]

    The list of (temporary) states of the address.

  • description string
  • validFrom date-time

    The date from which the state is valid.

  • validTo date-time

    The date until the state is valid.

  • type string

    Possible values: [ACTIVE, INACTIVE]

    One of the state types: active, inactive.

  • identifiers object[]

    The list of identifiers of the address.

  • value string

    The value of the identifier like "0847976000005".

  • type string

    The type of the identifier.

  • physicalPostalAddress object

    A physical postal address describes the physical location of an office, warehouse, gate, etc.

  • geographicCoordinates object

    The exact location of the physical postal address in latitude, longitude, and altitude.

  • longitude float

    Longitude coordinate

  • latitude float

    Latitude coordinate

  • altitude float

    Altitude, if applicable

  • country string

    Possible values: [UNDEFINED, AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BU, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CP, CR, CS, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, EU, EZ, FI, FJ, FK, FM, FO, FR, FX, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NT, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SF, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SU, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, UK, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XI, XU, XK, YE, YT, YU, ZA, ZM, ZR, ZW]

    The 2-digit country code of the physical postal address according to ISO 3166-1.

  • administrativeAreaLevel1 string

    The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country.

  • administrativeAreaLevel2 string

    The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country.

  • administrativeAreaLevel3 string

    The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country.

  • postalCode string

    The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code.

  • city string

    The name of the city of the physical postal address, synonyms: town, village, municipality.

  • district string

    The name of the district of the physical postal address which divides the city in several smaller areas.

  • street object

    The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway

  • namePrefix string

    The street related information, which is usually printed before the official street name on an address label.

  • additionalNamePrefix string

    The additional street related information, which is usually printed before the official street name on an address label.

  • name string

    The name of the street.

  • nameSuffix string

    The street related information, which is usually printed after the official street name on an address label.

  • additionalNameSuffix string

    The additional street related information, which is usually printed after the official street name on an address label.

  • houseNumber string

    The number representing the exact location of a building within the street.

  • houseNumberSupplement string
  • milestone string

    The number representing the exact location of an addressed object within a street without house numbers, such as within long roads.

  • direction string

    The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South.

  • companyPostalCode string

    The company postal code of the physical postal address, which is sometimes required for large companies.

  • industrialZone string

    The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area.

  • building string

    The alphanumeric identifier of the building addressed by the physical postal address.

  • floor string

    The number of a floor in the building addressed by the physical postal address, synonym: level.

  • door string

    The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite.

  • alternativePostalAddress object

    An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else.

  • geographicCoordinates object

    The exact location of the physical postal address in latitude, longitude, and altitude.

  • longitude float

    Longitude coordinate

  • latitude float

    Latitude coordinate

  • altitude float

    Altitude, if applicable

  • country string

    Possible values: [UNDEFINED, AC, AD, AE, AF, AG, AI, AL, AM, AN, AO, AQ, AR, AS, AT, AU, AW, AX, AZ, BA, BB, BD, BE, BF, BG, BH, BI, BJ, BL, BM, BN, BO, BQ, BR, BS, BT, BU, BV, BW, BY, BZ, CA, CC, CD, CF, CG, CH, CI, CK, CL, CM, CN, CO, CP, CR, CS, CU, CV, CW, CX, CY, CZ, DE, DG, DJ, DK, DM, DO, DZ, EA, EC, EE, EG, EH, ER, ES, ET, EU, EZ, FI, FJ, FK, FM, FO, FR, FX, GA, GB, GD, GE, GF, GG, GH, GI, GL, GM, GN, GP, GQ, GR, GS, GT, GU, GW, GY, HK, HM, HN, HR, HT, HU, IC, ID, IE, IL, IM, IN, IO, IQ, IR, IS, IT, JE, JM, JO, JP, KE, KG, KH, KI, KM, KN, KP, KR, KW, KY, KZ, LA, LB, LC, LI, LK, LR, LS, LT, LU, LV, LY, MA, MC, MD, ME, MF, MG, MH, MK, ML, MM, MN, MO, MP, MQ, MR, MS, MT, MU, MV, MW, MX, MY, MZ, NA, NC, NE, NF, NG, NI, NL, NO, NP, NR, NT, NU, NZ, OM, PA, PE, PF, PG, PH, PK, PL, PM, PN, PR, PS, PT, PW, PY, QA, RE, RO, RS, RU, RW, SA, SB, SC, SD, SE, SF, SG, SH, SI, SJ, SK, SL, SM, SN, SO, SR, SS, ST, SU, SV, SX, SY, SZ, TA, TC, TD, TF, TG, TH, TJ, TK, TL, TM, TN, TO, TP, TR, TT, TV, TW, TZ, UA, UG, UK, UM, US, UY, UZ, VA, VC, VE, VG, VI, VN, VU, WF, WS, XI, XU, XK, YE, YT, YU, ZA, ZM, ZR, ZW]

    The 2-digit country code of the physical postal address according to ISO 3166-1.

  • administrativeAreaLevel1 string

    The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country.

  • postalCode string

    The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code.

  • city string

    The name of the city of the physical postal address, synonyms: town, village, municipality.

  • deliveryServiceType string

    Possible values: [PO_BOX, PRIVATE_BAG, BOITE_POSTALE]

    One of the alternative postal address types: P.O. box, private bag, boite postale.

  • deliveryServiceQualifier string

    The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities.

  • deliveryServiceNumber string

    The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number.

  • roles string[]

    Possible values: [SUPPLIER, CUSTOMER, ONE_TIME_SUPPLIER, ONE_TIME_CUSTOMER]

    Roles this business partner takes in relation to the sharing member.

  • confidenceCriteria object
  • sharedByOwner boolean
  • checkedByExternalDataSource boolean
  • numberOfBusinessPartners int32
  • lastConfidenceCheckAt date-time
  • nextConfidenceCheckAt date-time
  • confidenceLevel int32
  • externalId string

    The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner.

  • legalEntityExternalId string

    The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner, representing the legal entity, that owns the address.

  • siteExternalId string

    The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner, representing the site, that the address belongs to.

  • bpna string

    A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity.

  • externalId string

    The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner.

  • bpnl string

    A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number.

Loading...